<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">











<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>XML Formatter Maven Plugin - xml-formatter:format</title>
    <style type="text/css" media="all">
      @import url("./css/maven-base.css");
      @import url("./css/maven-theme.css");
      @import url("./css/site.css");
    </style>
    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
        <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
      </head>
  <body class="composite">
    <div id="banner">
                    <span id="bannerLeft">
    
            XML Formatter Maven Plugin
    
            </span>
                    <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="breadcrumbs">
          
  

  
    
  
  
    
            <div class="xleft">
        Last Published: 2011-05-27
                      </div>
            <div class="xright">      
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="leftColumn">
      <div id="navcolumn">
           
  

  
    
  
  
    
                   <h5>Overview</h5>
            <ul>
              
    <li class="none">
                    <a href="index.html">Introduction</a>
          </li>
              
    <li class="none">
                    <a href="plugin-info.html">Goals</a>
          </li>
          </ul>
              <h5>Project Documentation</h5>
            <ul>
              
                
              
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
              
        <li class="collapsed">
                    <a href="project-info.html">Project Information</a>
                </li>
              
                
              
      
              
        <li class="collapsed">
                    <a href="project-reports.html">Project Reports</a>
                </li>
          </ul>
                                           <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
            <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
          </a>
                       
  

  
    
  
  
    
        </div>
    </div>
    <div id="bodyColumn">
      <div id="contentBox">
        <div class="section"><h2><a name="xml-formatter:format"></a>xml-formatter:format</h2>
<p><strong>Full name</strong>:</p>
<p>com.google.code.xml-formatter-maven-plugin:xml-formatter-maven-plugin:1.0-SNAPSHOT:format</p>
<p><strong>Description</strong>:</p>
<div>Goal that formats xml files.</div><p><strong>Attributes</strong>:</p>
<ul><li>Requires a Maven project to be executed.</li>
<li>Binds by default to the lifecycle phase: <code>generate-resources</code>.</li>
</ul>
<div class="section"><h3><a name="Required_Parameters"></a>Required Parameters</h3>
<table class="bodyTable"><tr class="a"><th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b"><td><strong><a href="#formatAddXmlDeclaration">formatAddXmlDeclaration</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Add xml declaration if needed.<br />
<strong>Default value is</strong>: <code>true</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#formatIndent">formatIndent</a></strong></td>
<td><code>int</code></td>
<td><code>-</code></td>
<td>Indentation size.<br />
<strong>Default value is</strong>: <code>4</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#formatIndenting">formatIndenting</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Indent xml files.<br />
<strong>Default value is</strong>: <code>true</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#formatLineWidth">formatLineWidth</a></strong></td>
<td><code>int</code></td>
<td><code>-</code></td>
<td>Line width for xml files.<br />
<strong>Default value is</strong>: <code>80</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#formatReformatSchemaLocation">formatReformatSchemaLocation</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Re-format value of schemaLocation attribute.<br />
<strong>Default value is</strong>: <code>true</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#root">root</a></strong></td>
<td><code>File</code></td>
<td><code>-</code></td>
<td>Base directory where to search for files.<br />
<strong>Default value is</strong>: <code>${basedir}</code>.</td>
</tr>
</table>
</div>
<div class="section"><h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="bodyTable"><tr class="b"><th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="a"><td><strong><a href="#excludes">excludes</a></strong></td>
<td><code>String[]</code></td>
<td><code>-</code></td>
<td>Patterns of files to exclude. Default is target/**<br />
</td>
</tr>
<tr class="b"><td><strong><a href="#formatEOL">formatEOL</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>End of line style to use. Could be one of: NATIVE, LF, CRLF. Native
line ending are used by default.<br />
</td>
</tr>
<tr class="a"><td><strong><a href="#includes">includes</a></strong></td>
<td><code>String[]</code></td>
<td><code>-</code></td>
<td>Patterns of files to include. Default is pom.xml, src/** /*.xml<br />
</td>
</tr>
<tr class="b"><td><strong><a href="#verbose">verbose</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Print verbose output.<br />
<strong>Default value is</strong>: <code>true</code>.</td>
</tr>
</table>
</div>
<div class="section"><h3><a name="Parameter_Details"></a>Parameter Details</h3>
<p><strong><a name="excludes">excludes</a>:</strong></p>
<div>Patterns of files to exclude. Default is target/**</div><ul><li><strong>Type</strong>: <code>java.lang.String[]</code></li>
<li><strong>Required</strong>: <code>No</code></li>
</ul>
<hr />
<p><strong><a name="formatAddXmlDeclaration">formatAddXmlDeclaration</a>:</strong></p>
<div>Add xml declaration if needed.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>: <code>true</code></li>
</ul>
<hr />
<p><strong><a name="formatEOL">formatEOL</a>:</strong></p>
<div>End of line style to use. Could be one of: NATIVE, LF, CRLF. Native
line ending are used by default.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
</ul>
<hr />
<p><strong><a name="formatIndent">formatIndent</a>:</strong></p>
<div>Indentation size.</div><ul><li><strong>Type</strong>: <code>int</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>: <code>4</code></li>
</ul>
<hr />
<p><strong><a name="formatIndenting">formatIndenting</a>:</strong></p>
<div>Indent xml files.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>: <code>true</code></li>
</ul>
<hr />
<p><strong><a name="formatLineWidth">formatLineWidth</a>:</strong></p>
<div>Line width for xml files.</div><ul><li><strong>Type</strong>: <code>int</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>: <code>80</code></li>
</ul>
<hr />
<p><strong><a name="formatReformatSchemaLocation">formatReformatSchemaLocation</a>:</strong></p>
<div>Re-format value of schemaLocation attribute.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>: <code>true</code></li>
</ul>
<hr />
<p><strong><a name="includes">includes</a>:</strong></p>
<div>Patterns of files to include. Default is pom.xml, src/** /*.xml</div><ul><li><strong>Type</strong>: <code>java.lang.String[]</code></li>
<li><strong>Required</strong>: <code>No</code></li>
</ul>
<hr />
<p><strong><a name="root">root</a>:</strong></p>
<div>Base directory where to search for files.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>: <code>${basedir}</code></li>
</ul>
<hr />
<p><strong><a name="verbose">verbose</a>:</strong></p>
<div>Print verbose output.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>: <code>true</code></li>
</ul>
</div>
</div>

      </div>
    </div>
    <div class="clear">
      <hr/>
    </div>
    <div id="footer">
      <div class="xright">&#169;  
          2011
    
          
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
  </body>
</html>
